using Umbraco.Cms.Core.Composing;

namespace Umbraco.Cms.Core.PropertyEditors;

/// <summary>
///     Represents a void editor.
/// </summary>
/// <remarks>
///     Can be used in some places where an editor is needed but no actual
///     editor is available. Not to be used otherwise. Not discovered, and therefore
///     not part of the editors collection.
/// </remarks>
[HideFromTypeFinder]
public class VoidEditor : DataEditor
{
    /// <summary>
    ///     Initializes a new instance of the <see cref="VoidEditor" /> class.
    /// </summary>
    /// <param name="aliasSuffix">An optional alias suffix.</param>
    /// <param name="dataValueEditorFactory">A data value editor factory.</param>
    /// <remarks>
    ///     The default alias of the editor is "Umbraco.Void". When a suffix is provided,
    ///     it is appended to the alias. Eg if the suffix is "Foo" the alias is "Umbraco.Void.Foo".
    /// </remarks>
    public VoidEditor(
        string? aliasSuffix,
        IDataValueEditorFactory dataValueEditorFactory)
        : base(dataValueEditorFactory)
    {
        Alias = "Umbraco.Void";
        if (string.IsNullOrWhiteSpace(aliasSuffix))
        {
            return;
        }

        Alias += "." + aliasSuffix;
    }

    /// <summary>
    ///     Initializes a new instance of the <see cref="VoidEditor" /> class.
    /// </summary>
    /// <param name="dataValueEditorFactory">A data value editor factory.</param>
    /// <remarks>The alias of the editor is "Umbraco.Void".</remarks>
    public VoidEditor(
        IDataValueEditorFactory dataValueEditorFactory)
        : this(null, dataValueEditorFactory)
    {
    }
}
